home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / include / linux / usb / ch9.h < prev    next >
C/C++ Source or Header  |  2009-10-16  |  25KB  |  800 lines
  1. /*
  2.  * This file holds USB constants and structures that are needed for
  3.  * USB device APIs.  These are used by the USB device model, which is
  4.  * defined in chapter 9 of the USB 2.0 specification and in the
  5.  * Wireless USB 1.0 (spread around).  Linux has several APIs in C that
  6.  * need these:
  7.  *
  8.  * - the master/host side Linux-USB kernel driver API;
  9.  * - the "usbfs" user space API; and
  10.  * - the Linux "gadget" slave/device/peripheral side driver API.
  11.  *
  12.  * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems
  13.  * act either as a USB master/host or as a USB slave/device.  That means
  14.  * the master and slave side APIs benefit from working well together.
  15.  *
  16.  * There's also "Wireless USB", using low power short range radios for
  17.  * peripheral interconnection but otherwise building on the USB framework.
  18.  *
  19.  * Note all descriptors are declared '__attribute__((packed))' so that:
  20.  *
  21.  * [a] they never get padded, either internally (USB spec writers
  22.  *     probably handled that) or externally;
  23.  *
  24.  * [b] so that accessing bigger-than-a-bytes fields will never
  25.  *     generate bus errors on any platform, even when the location of
  26.  *     its descriptor inside a bundle isn't "naturally aligned", and
  27.  *
  28.  * [c] for consistency, removing all doubt even when it appears to
  29.  *     someone that the two other points are non-issues for that
  30.  *     particular descriptor type.
  31.  */
  32.  
  33. #ifndef __LINUX_USB_CH9_H
  34. #define __LINUX_USB_CH9_H
  35.  
  36. #include <linux/types.h>    /* __u8 etc */
  37.  
  38. /*-------------------------------------------------------------------------*/
  39.  
  40. /* CONTROL REQUEST SUPPORT */
  41.  
  42. /*
  43.  * USB directions
  44.  *
  45.  * This bit flag is used in endpoint descriptors' bEndpointAddress field.
  46.  * It's also one of three fields in control requests bRequestType.
  47.  */
  48. #define USB_DIR_OUT            0        /* to device */
  49. #define USB_DIR_IN            0x80        /* to host */
  50.  
  51. /*
  52.  * USB types, the second of three bRequestType fields
  53.  */
  54. #define USB_TYPE_MASK            (0x03 << 5)
  55. #define USB_TYPE_STANDARD        (0x00 << 5)
  56. #define USB_TYPE_CLASS            (0x01 << 5)
  57. #define USB_TYPE_VENDOR            (0x02 << 5)
  58. #define USB_TYPE_RESERVED        (0x03 << 5)
  59.  
  60. /*
  61.  * USB recipients, the third of three bRequestType fields
  62.  */
  63. #define USB_RECIP_MASK            0x1f
  64. #define USB_RECIP_DEVICE        0x00
  65. #define USB_RECIP_INTERFACE        0x01
  66. #define USB_RECIP_ENDPOINT        0x02
  67. #define USB_RECIP_OTHER            0x03
  68. /* From Wireless USB 1.0 */
  69. #define USB_RECIP_PORT            0x04
  70. #define USB_RECIP_RPIPE        0x05
  71.  
  72. /*
  73.  * Standard requests, for the bRequest field of a SETUP packet.
  74.  *
  75.  * These are qualified by the bRequestType field, so that for example
  76.  * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved
  77.  * by a GET_STATUS request.
  78.  */
  79. #define USB_REQ_GET_STATUS        0x00
  80. #define USB_REQ_CLEAR_FEATURE        0x01
  81. #define USB_REQ_SET_FEATURE        0x03
  82. #define USB_REQ_SET_ADDRESS        0x05
  83. #define USB_REQ_GET_DESCRIPTOR        0x06
  84. #define USB_REQ_SET_DESCRIPTOR        0x07
  85. #define USB_REQ_GET_CONFIGURATION    0x08
  86. #define USB_REQ_SET_CONFIGURATION    0x09
  87. #define USB_REQ_GET_INTERFACE        0x0A
  88. #define USB_REQ_SET_INTERFACE        0x0B
  89. #define USB_REQ_SYNCH_FRAME        0x0C
  90.  
  91. #define USB_REQ_SET_ENCRYPTION        0x0D    /* Wireless USB */
  92. #define USB_REQ_GET_ENCRYPTION        0x0E
  93. #define USB_REQ_RPIPE_ABORT        0x0E
  94. #define USB_REQ_SET_HANDSHAKE        0x0F
  95. #define USB_REQ_RPIPE_RESET        0x0F
  96. #define USB_REQ_GET_HANDSHAKE        0x10
  97. #define USB_REQ_SET_CONNECTION        0x11
  98. #define USB_REQ_SET_SECURITY_DATA    0x12
  99. #define USB_REQ_GET_SECURITY_DATA    0x13
  100. #define USB_REQ_SET_WUSB_DATA        0x14
  101. #define USB_REQ_LOOPBACK_DATA_WRITE    0x15
  102. #define USB_REQ_LOOPBACK_DATA_READ    0x16
  103. #define USB_REQ_SET_INTERFACE_DS    0x17
  104.  
  105. /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
  106.  * used by hubs to put ports into a new L1 suspend state, except that it
  107.  * forgot to define its number ...
  108.  */
  109.  
  110. /*
  111.  * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
  112.  * are read as a bit array returned by USB_REQ_GET_STATUS.  (So there
  113.  * are at most sixteen features of each type.)  Hubs may also support a
  114.  * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
  115.  */
  116. #define USB_DEVICE_SELF_POWERED        0    /* (read only) */
  117. #define USB_DEVICE_REMOTE_WAKEUP    1    /* dev may initiate wakeup */
  118. #define USB_DEVICE_TEST_MODE        2    /* (wired high speed only) */
  119. #define USB_DEVICE_BATTERY        2    /* (wireless) */
  120. #define USB_DEVICE_B_HNP_ENABLE        3    /* (otg) dev may initiate HNP */
  121. #define USB_DEVICE_WUSB_DEVICE        3    /* (wireless)*/
  122. #define USB_DEVICE_A_HNP_SUPPORT    4    /* (otg) RH port supports HNP */
  123. #define USB_DEVICE_A_ALT_HNP_SUPPORT    5    /* (otg) other RH port does */
  124. #define USB_DEVICE_DEBUG_MODE        6    /* (special devices only) */
  125.  
  126. #define USB_ENDPOINT_HALT        0    /* IN/OUT will STALL */
  127.  
  128.  
  129. /**
  130.  * struct usb_ctrlrequest - SETUP data for a USB device control request
  131.  * @bRequestType: matches the USB bmRequestType field
  132.  * @bRequest: matches the USB bRequest field
  133.  * @wValue: matches the USB wValue field (le16 byte order)
  134.  * @wIndex: matches the USB wIndex field (le16 byte order)
  135.  * @wLength: matches the USB wLength field (le16 byte order)
  136.  *
  137.  * This structure is used to send control requests to a USB device.  It matches
  138.  * the different fields of the USB 2.0 Spec section 9.3, table 9-2.  See the
  139.  * USB spec for a fuller description of the different fields, and what they are
  140.  * used for.
  141.  *
  142.  * Note that the driver for any interface can issue control requests.
  143.  * For most devices, interfaces don't coordinate with each other, so
  144.  * such requests may be made at any time.
  145.  */
  146. struct usb_ctrlrequest {
  147.     __u8 bRequestType;
  148.     __u8 bRequest;
  149.     __le16 wValue;
  150.     __le16 wIndex;
  151.     __le16 wLength;
  152. } __attribute__ ((packed));
  153.  
  154. /*-------------------------------------------------------------------------*/
  155.  
  156. /*
  157.  * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
  158.  * (rarely) accepted by SET_DESCRIPTOR.
  159.  *
  160.  * Note that all multi-byte values here are encoded in little endian
  161.  * byte order "on the wire".  Within the kernel and when exposed
  162.  * through the Linux-USB APIs, they are not converted to cpu byte
  163.  * order; it is the responsibility of the client code to do this.
  164.  * The single exception is when device and configuration descriptors (but
  165.  * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD);
  166.  * in this case the fields are converted to host endianness by the kernel.
  167.  */
  168.  
  169. /*
  170.  * Descriptor types ... USB 2.0 spec table 9.5
  171.  */
  172. #define USB_DT_DEVICE            0x01
  173. #define USB_DT_CONFIG            0x02
  174. #define USB_DT_STRING            0x03
  175. #define USB_DT_INTERFACE        0x04
  176. #define USB_DT_ENDPOINT            0x05
  177. #define USB_DT_DEVICE_QUALIFIER        0x06
  178. #define USB_DT_OTHER_SPEED_CONFIG    0x07
  179. #define USB_DT_INTERFACE_POWER        0x08
  180. /* these are from a minor usb 2.0 revision (ECN) */
  181. #define USB_DT_OTG            0x09
  182. #define USB_DT_DEBUG            0x0a
  183. #define USB_DT_INTERFACE_ASSOCIATION    0x0b
  184. /* these are from the Wireless USB spec */
  185. #define USB_DT_SECURITY            0x0c
  186. #define USB_DT_KEY            0x0d
  187. #define USB_DT_ENCRYPTION_TYPE        0x0e
  188. #define USB_DT_BOS            0x0f
  189. #define USB_DT_DEVICE_CAPABILITY    0x10
  190. #define USB_DT_WIRELESS_ENDPOINT_COMP    0x11
  191. #define USB_DT_WIRE_ADAPTER        0x21
  192. #define USB_DT_RPIPE            0x22
  193. #define USB_DT_CS_RADIO_CONTROL        0x23
  194. /* From the USB 3.0 spec */
  195. #define    USB_DT_SS_ENDPOINT_COMP        0x30
  196.  
  197. /* Conventional codes for class-specific descriptors.  The convention is
  198.  * defined in the USB "Common Class" Spec (3.11).  Individual class specs
  199.  * are authoritative for their usage, not the "common class" writeup.
  200.  */
  201. #define USB_DT_CS_DEVICE        (USB_TYPE_CLASS | USB_DT_DEVICE)
  202. #define USB_DT_CS_CONFIG        (USB_TYPE_CLASS | USB_DT_CONFIG)
  203. #define USB_DT_CS_STRING        (USB_TYPE_CLASS | USB_DT_STRING)
  204. #define USB_DT_CS_INTERFACE        (USB_TYPE_CLASS | USB_DT_INTERFACE)
  205. #define USB_DT_CS_ENDPOINT        (USB_TYPE_CLASS | USB_DT_ENDPOINT)
  206.  
  207. /* All standard descriptors have these 2 fields at the beginning */
  208. struct usb_descriptor_header {
  209.     __u8  bLength;
  210.     __u8  bDescriptorType;
  211. } __attribute__ ((packed));
  212.  
  213.  
  214. /*-------------------------------------------------------------------------*/
  215.  
  216. /* USB_DT_DEVICE: Device descriptor */
  217. struct usb_device_descriptor {
  218.     __u8  bLength;
  219.     __u8  bDescriptorType;
  220.  
  221.     __le16 bcdUSB;
  222.     __u8  bDeviceClass;
  223.     __u8  bDeviceSubClass;
  224.     __u8  bDeviceProtocol;
  225.     __u8  bMaxPacketSize0;
  226.     __le16 idVendor;
  227.     __le16 idProduct;
  228.     __le16 bcdDevice;
  229.     __u8  iManufacturer;
  230.     __u8  iProduct;
  231.     __u8  iSerialNumber;
  232.     __u8  bNumConfigurations;
  233. } __attribute__ ((packed));
  234.  
  235. #define USB_DT_DEVICE_SIZE        18
  236.  
  237.  
  238. /*
  239.  * Device and/or Interface Class codes
  240.  * as found in bDeviceClass or bInterfaceClass
  241.  * and defined by www.usb.org documents
  242.  */
  243. #define USB_CLASS_PER_INTERFACE        0    /* for DeviceClass */
  244. #define USB_CLASS_AUDIO            1
  245. #define USB_CLASS_COMM            2
  246. #define USB_CLASS_HID            3
  247. #define USB_CLASS_PHYSICAL        5
  248. #define USB_CLASS_STILL_IMAGE        6
  249. #define USB_CLASS_PRINTER        7
  250. #define USB_CLASS_MASS_STORAGE        8
  251. #define USB_CLASS_HUB            9
  252. #define USB_CLASS_CDC_DATA        0x0a
  253. #define USB_CLASS_CSCID            0x0b    /* chip+ smart card */
  254. #define USB_CLASS_CONTENT_SEC        0x0d    /* content security */
  255. #define USB_CLASS_VIDEO            0x0e
  256. #define USB_CLASS_WIRELESS_CONTROLLER    0xe0
  257. #define USB_CLASS_MISC            0xef
  258. #define USB_CLASS_APP_SPEC        0xfe
  259. #define USB_CLASS_VENDOR_SPEC        0xff
  260.  
  261. /*-------------------------------------------------------------------------*/
  262.  
  263. /* USB_DT_CONFIG: Configuration descriptor information.
  264.  *
  265.  * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
  266.  * descriptor type is different.  Highspeed-capable devices can look
  267.  * different depending on what speed they're currently running.  Only
  268.  * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
  269.  * descriptors.
  270.  */
  271. struct usb_config_descriptor {
  272.     __u8  bLength;
  273.     __u8  bDescriptorType;
  274.  
  275.     __le16 wTotalLength;
  276.     __u8  bNumInterfaces;
  277.     __u8  bConfigurationValue;
  278.     __u8  iConfiguration;
  279.     __u8  bmAttributes;
  280.     __u8  bMaxPower;
  281. } __attribute__ ((packed));
  282.  
  283. #define USB_DT_CONFIG_SIZE        9
  284.  
  285. /* from config descriptor bmAttributes */
  286. #define USB_CONFIG_ATT_ONE        (1 << 7)    /* must be set */
  287. #define USB_CONFIG_ATT_SELFPOWER    (1 << 6)    /* self powered */
  288. #define USB_CONFIG_ATT_WAKEUP        (1 << 5)    /* can wakeup */
  289. #define USB_CONFIG_ATT_BATTERY        (1 << 4)    /* battery powered */
  290.  
  291. /*-------------------------------------------------------------------------*/
  292.  
  293. /* USB_DT_STRING: String descriptor */
  294. struct usb_string_descriptor {
  295.     __u8  bLength;
  296.     __u8  bDescriptorType;
  297.  
  298.     __le16 wData[1];        /* UTF-16LE encoded */
  299. } __attribute__ ((packed));
  300.  
  301. /* note that "string" zero is special, it holds language codes that
  302.  * the device supports, not Unicode characters.
  303.  */
  304.  
  305. /*-------------------------------------------------------------------------*/
  306.  
  307. /* USB_DT_INTERFACE: Interface descriptor */
  308. struct usb_interface_descriptor {
  309.     __u8  bLength;
  310.     __u8  bDescriptorType;
  311.  
  312.     __u8  bInterfaceNumber;
  313.     __u8  bAlternateSetting;
  314.     __u8  bNumEndpoints;
  315.     __u8  bInterfaceClass;
  316.     __u8  bInterfaceSubClass;
  317.     __u8  bInterfaceProtocol;
  318.     __u8  iInterface;
  319. } __attribute__ ((packed));
  320.  
  321. #define USB_DT_INTERFACE_SIZE        9
  322.  
  323. /*-------------------------------------------------------------------------*/
  324.  
  325. /* USB_DT_ENDPOINT: Endpoint descriptor */
  326. struct usb_endpoint_descriptor {
  327.     __u8  bLength;
  328.     __u8  bDescriptorType;
  329.  
  330.     __u8  bEndpointAddress;
  331.     __u8  bmAttributes;
  332.     __le16 wMaxPacketSize;
  333.     __u8  bInterval;
  334.  
  335.     /* NOTE:  these two are _only_ in audio endpoints. */
  336.     /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
  337.     __u8  bRefresh;
  338.     __u8  bSynchAddress;
  339. } __attribute__ ((packed));
  340.  
  341. #define USB_DT_ENDPOINT_SIZE        7
  342. #define USB_DT_ENDPOINT_AUDIO_SIZE    9    /* Audio extension */
  343.  
  344.  
  345. /*
  346.  * Endpoints
  347.  */
  348. #define USB_ENDPOINT_NUMBER_MASK    0x0f    /* in bEndpointAddress */
  349. #define USB_ENDPOINT_DIR_MASK        0x80
  350.  
  351. #define USB_ENDPOINT_XFERTYPE_MASK    0x03    /* in bmAttributes */
  352. #define USB_ENDPOINT_XFER_CONTROL    0
  353. #define USB_ENDPOINT_XFER_ISOC        1
  354. #define USB_ENDPOINT_XFER_BULK        2
  355. #define USB_ENDPOINT_XFER_INT        3
  356. #define USB_ENDPOINT_MAX_ADJUSTABLE    0x80
  357.  
  358. /*-------------------------------------------------------------------------*/
  359.  
  360. /**
  361.  * usb_endpoint_num - get the endpoint's number
  362.  * @epd: endpoint to be checked
  363.  *
  364.  * Returns @epd's number: 0 to 15.
  365.  */
  366. static __inline__ int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
  367. {
  368.     return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
  369. }
  370.  
  371. /**
  372.  * usb_endpoint_type - get the endpoint's transfer type
  373.  * @epd: endpoint to be checked
  374.  *
  375.  * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
  376.  * to @epd's transfer type.
  377.  */
  378. static __inline__ int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
  379. {
  380.     return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
  381. }
  382.  
  383. /**
  384.  * usb_endpoint_dir_in - check if the endpoint has IN direction
  385.  * @epd: endpoint to be checked
  386.  *
  387.  * Returns true if the endpoint is of type IN, otherwise it returns false.
  388.  */
  389. static __inline__ int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
  390. {
  391.     return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
  392. }
  393.  
  394. /**
  395.  * usb_endpoint_dir_out - check if the endpoint has OUT direction
  396.  * @epd: endpoint to be checked
  397.  *
  398.  * Returns true if the endpoint is of type OUT, otherwise it returns false.
  399.  */
  400. static __inline__ int usb_endpoint_dir_out(
  401.                 const struct usb_endpoint_descriptor *epd)
  402. {
  403.     return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
  404. }
  405.  
  406. /**
  407.  * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
  408.  * @epd: endpoint to be checked
  409.  *
  410.  * Returns true if the endpoint is of type bulk, otherwise it returns false.
  411.  */
  412. static __inline__ int usb_endpoint_xfer_bulk(
  413.                 const struct usb_endpoint_descriptor *epd)
  414. {
  415.     return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
  416.         USB_ENDPOINT_XFER_BULK);
  417. }
  418.  
  419. /**
  420.  * usb_endpoint_xfer_control - check if the endpoint has control transfer type
  421.  * @epd: endpoint to be checked
  422.  *
  423.  * Returns true if the endpoint is of type control, otherwise it returns false.
  424.  */
  425. static __inline__ int usb_endpoint_xfer_control(
  426.                 const struct usb_endpoint_descriptor *epd)
  427. {
  428.     return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
  429.         USB_ENDPOINT_XFER_CONTROL);
  430. }
  431.  
  432. /**
  433.  * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
  434.  * @epd: endpoint to be checked
  435.  *
  436.  * Returns true if the endpoint is of type interrupt, otherwise it returns
  437.  * false.
  438.  */
  439. static __inline__ int usb_endpoint_xfer_int(
  440.                 const struct usb_endpoint_descriptor *epd)
  441. {
  442.     return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
  443.         USB_ENDPOINT_XFER_INT);
  444. }
  445.  
  446. /**
  447.  * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
  448.  * @epd: endpoint to be checked
  449.  *
  450.  * Returns true if the endpoint is of type isochronous, otherwise it returns
  451.  * false.
  452.  */
  453. static __inline__ int usb_endpoint_xfer_isoc(
  454.                 const struct usb_endpoint_descriptor *epd)
  455. {
  456.     return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
  457.         USB_ENDPOINT_XFER_ISOC);
  458. }
  459.  
  460. /**
  461.  * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
  462.  * @epd: endpoint to be checked
  463.  *
  464.  * Returns true if the endpoint has bulk transfer type and IN direction,
  465.  * otherwise it returns false.
  466.  */
  467. static __inline__ int usb_endpoint_is_bulk_in(
  468.                 const struct usb_endpoint_descriptor *epd)
  469. {
  470.     return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
  471. }
  472.  
  473. /**
  474.  * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
  475.  * @epd: endpoint to be checked
  476.  *
  477.  * Returns true if the endpoint has bulk transfer type and OUT direction,
  478.  * otherwise it returns false.
  479.  */
  480. static __inline__ int usb_endpoint_is_bulk_out(
  481.                 const struct usb_endpoint_descriptor *epd)
  482. {
  483.     return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
  484. }
  485.  
  486. /**
  487.  * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
  488.  * @epd: endpoint to be checked
  489.  *
  490.  * Returns true if the endpoint has interrupt transfer type and IN direction,
  491.  * otherwise it returns false.
  492.  */
  493. static __inline__ int usb_endpoint_is_int_in(
  494.                 const struct usb_endpoint_descriptor *epd)
  495. {
  496.     return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
  497. }
  498.  
  499. /**
  500.  * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
  501.  * @epd: endpoint to be checked
  502.  *
  503.  * Returns true if the endpoint has interrupt transfer type and OUT direction,
  504.  * otherwise it returns false.
  505.  */
  506. static __inline__ int usb_endpoint_is_int_out(
  507.                 const struct usb_endpoint_descriptor *epd)
  508. {
  509.     return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
  510. }
  511.  
  512. /**
  513.  * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
  514.  * @epd: endpoint to be checked
  515.  *
  516.  * Returns true if the endpoint has isochronous transfer type and IN direction,
  517.  * otherwise it returns false.
  518.  */
  519. static __inline__ int usb_endpoint_is_isoc_in(
  520.                 const struct usb_endpoint_descriptor *epd)
  521. {
  522.     return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
  523. }
  524.  
  525. /**
  526.  * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
  527.  * @epd: endpoint to be checked
  528.  *
  529.  * Returns true if the endpoint has isochronous transfer type and OUT direction,
  530.  * otherwise it returns false.
  531.  */
  532. static __inline__ int usb_endpoint_is_isoc_out(
  533.                 const struct usb_endpoint_descriptor *epd)
  534. {
  535.     return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
  536. }
  537.  
  538. /*-------------------------------------------------------------------------*/
  539.  
  540. /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
  541. struct usb_ss_ep_comp_descriptor {
  542.     __u8  bLength;
  543.     __u8  bDescriptorType;
  544.  
  545.     __u8  bMaxBurst;
  546.     __u8  bmAttributes;
  547.     __u16 wBytesPerInterval;
  548. } __attribute__ ((packed));
  549.  
  550. #define USB_DT_SS_EP_COMP_SIZE        6
  551.  
  552. /*-------------------------------------------------------------------------*/
  553.  
  554. /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
  555. struct usb_qualifier_descriptor {
  556.     __u8  bLength;
  557.     __u8  bDescriptorType;
  558.  
  559.     __le16 bcdUSB;
  560.     __u8  bDeviceClass;
  561.     __u8  bDeviceSubClass;
  562.     __u8  bDeviceProtocol;
  563.     __u8  bMaxPacketSize0;
  564.     __u8  bNumConfigurations;
  565.     __u8  bRESERVED;
  566. } __attribute__ ((packed));
  567.  
  568.  
  569. /*-------------------------------------------------------------------------*/
  570.  
  571. /* USB_DT_OTG (from OTG 1.0a supplement) */
  572. struct usb_otg_descriptor {
  573.     __u8  bLength;
  574.     __u8  bDescriptorType;
  575.  
  576.     __u8  bmAttributes;    /* support for HNP, SRP, etc */
  577. } __attribute__ ((packed));
  578.  
  579. /* from usb_otg_descriptor.bmAttributes */
  580. #define USB_OTG_SRP        (1 << 0)
  581. #define USB_OTG_HNP        (1 << 1)    /* swap host/device roles */
  582.  
  583. /*-------------------------------------------------------------------------*/
  584.  
  585. /* USB_DT_DEBUG:  for special highspeed devices, replacing serial console */
  586. struct usb_debug_descriptor {
  587.     __u8  bLength;
  588.     __u8  bDescriptorType;
  589.  
  590.     /* bulk endpoints with 8 byte maxpacket */
  591.     __u8  bDebugInEndpoint;
  592.     __u8  bDebugOutEndpoint;
  593. } __attribute__((packed));
  594.  
  595. /*-------------------------------------------------------------------------*/
  596.  
  597. /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
  598. struct usb_interface_assoc_descriptor {
  599.     __u8  bLength;
  600.     __u8  bDescriptorType;
  601.  
  602.     __u8  bFirstInterface;
  603.     __u8  bInterfaceCount;
  604.     __u8  bFunctionClass;
  605.     __u8  bFunctionSubClass;
  606.     __u8  bFunctionProtocol;
  607.     __u8  iFunction;
  608. } __attribute__ ((packed));
  609.  
  610.  
  611. /*-------------------------------------------------------------------------*/
  612.  
  613. /* USB_DT_SECURITY:  group of wireless security descriptors, including
  614.  * encryption types available for setting up a CC/association.
  615.  */
  616. struct usb_security_descriptor {
  617.     __u8  bLength;
  618.     __u8  bDescriptorType;
  619.  
  620.     __le16 wTotalLength;
  621.     __u8  bNumEncryptionTypes;
  622. } __attribute__((packed));
  623.  
  624. /*-------------------------------------------------------------------------*/
  625.  
  626. /* USB_DT_KEY:  used with {GET,SET}_SECURITY_DATA; only public keys
  627.  * may be retrieved.
  628.  */
  629. struct usb_key_descriptor {
  630.     __u8  bLength;
  631.     __u8  bDescriptorType;
  632.  
  633.     __u8  tTKID[3];
  634.     __u8  bReserved;
  635.     __u8  bKeyData[0];
  636. } __attribute__((packed));
  637.  
  638. /*-------------------------------------------------------------------------*/
  639.  
  640. /* USB_DT_ENCRYPTION_TYPE:  bundled in DT_SECURITY groups */
  641. struct usb_encryption_descriptor {
  642.     __u8  bLength;
  643.     __u8  bDescriptorType;
  644.  
  645.     __u8  bEncryptionType;
  646. #define    USB_ENC_TYPE_UNSECURE        0
  647. #define    USB_ENC_TYPE_WIRED        1    /* non-wireless mode */
  648. #define    USB_ENC_TYPE_CCM_1        2    /* aes128/cbc session */
  649. #define    USB_ENC_TYPE_RSA_1        3    /* rsa3072/sha1 auth */
  650.     __u8  bEncryptionValue;        /* use in SET_ENCRYPTION */
  651.     __u8  bAuthKeyIndex;
  652. } __attribute__((packed));
  653.  
  654.  
  655. /*-------------------------------------------------------------------------*/
  656.  
  657. /* USB_DT_BOS:  group of device-level capabilities */
  658. struct usb_bos_descriptor {
  659.     __u8  bLength;
  660.     __u8  bDescriptorType;
  661.  
  662.     __le16 wTotalLength;
  663.     __u8  bNumDeviceCaps;
  664. } __attribute__((packed));
  665.  
  666. /*-------------------------------------------------------------------------*/
  667.  
  668. /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
  669. struct usb_dev_cap_header {
  670.     __u8  bLength;
  671.     __u8  bDescriptorType;
  672.     __u8  bDevCapabilityType;
  673. } __attribute__((packed));
  674.  
  675. #define    USB_CAP_TYPE_WIRELESS_USB    1
  676.  
  677. struct usb_wireless_cap_descriptor {    /* Ultra Wide Band */
  678.     __u8  bLength;
  679.     __u8  bDescriptorType;
  680.     __u8  bDevCapabilityType;
  681.  
  682.     __u8  bmAttributes;
  683. #define    USB_WIRELESS_P2P_DRD        (1 << 1)
  684. #define    USB_WIRELESS_BEACON_MASK    (3 << 2)
  685. #define    USB_WIRELESS_BEACON_SELF    (1 << 2)
  686. #define    USB_WIRELESS_BEACON_DIRECTED    (2 << 2)
  687. #define    USB_WIRELESS_BEACON_NONE    (3 << 2)
  688.     __le16 wPHYRates;    /* bit rates, Mbps */
  689. #define    USB_WIRELESS_PHY_53        (1 << 0)    /* always set */
  690. #define    USB_WIRELESS_PHY_80        (1 << 1)
  691. #define    USB_WIRELESS_PHY_107        (1 << 2)    /* always set */
  692. #define    USB_WIRELESS_PHY_160        (1 << 3)
  693. #define    USB_WIRELESS_PHY_200        (1 << 4)    /* always set */
  694. #define    USB_WIRELESS_PHY_320        (1 << 5)
  695. #define    USB_WIRELESS_PHY_400        (1 << 6)
  696. #define    USB_WIRELESS_PHY_480        (1 << 7)
  697.     __u8  bmTFITXPowerInfo;    /* TFI power levels */
  698.     __u8  bmFFITXPowerInfo;    /* FFI power levels */
  699.     __le16 bmBandGroup;
  700.     __u8  bReserved;
  701. } __attribute__((packed));
  702.  
  703. #define    USB_CAP_TYPE_EXT        2
  704.  
  705. struct usb_ext_cap_descriptor {        /* Link Power Management */
  706.     __u8  bLength;
  707.     __u8  bDescriptorType;
  708.     __u8  bDevCapabilityType;
  709.     __u8  bmAttributes;
  710. #define USB_LPM_SUPPORT            (1 << 1)    /* supports LPM */
  711. } __attribute__((packed));
  712.  
  713. /*-------------------------------------------------------------------------*/
  714.  
  715. /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
  716.  * each endpoint descriptor for a wireless device
  717.  */
  718. struct usb_wireless_ep_comp_descriptor {
  719.     __u8  bLength;
  720.     __u8  bDescriptorType;
  721.  
  722.     __u8  bMaxBurst;
  723.     __u8  bMaxSequence;
  724.     __le16 wMaxStreamDelay;
  725.     __le16 wOverTheAirPacketSize;
  726.     __u8  bOverTheAirInterval;
  727.     __u8  bmCompAttributes;
  728. #define USB_ENDPOINT_SWITCH_MASK    0x03    /* in bmCompAttributes */
  729. #define USB_ENDPOINT_SWITCH_NO        0
  730. #define USB_ENDPOINT_SWITCH_SWITCH    1
  731. #define USB_ENDPOINT_SWITCH_SCALE    2
  732. } __attribute__((packed));
  733.  
  734. /*-------------------------------------------------------------------------*/
  735.  
  736. /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
  737.  * host and a device for connection set up, mutual authentication, and
  738.  * exchanging short lived session keys.  The handshake depends on a CC.
  739.  */
  740. struct usb_handshake {
  741.     __u8 bMessageNumber;
  742.     __u8 bStatus;
  743.     __u8 tTKID[3];
  744.     __u8 bReserved;
  745.     __u8 CDID[16];
  746.     __u8 nonce[16];
  747.     __u8 MIC[8];
  748. } __attribute__((packed));
  749.  
  750. /*-------------------------------------------------------------------------*/
  751.  
  752. /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
  753.  * A CC may also be set up using non-wireless secure channels (including
  754.  * wired USB!), and some devices may support CCs with multiple hosts.
  755.  */
  756. struct usb_connection_context {
  757.     __u8 CHID[16];        /* persistent host id */
  758.     __u8 CDID[16];        /* device id (unique w/in host context) */
  759.     __u8 CK[16];        /* connection key */
  760. } __attribute__((packed));
  761.  
  762. /*-------------------------------------------------------------------------*/
  763.  
  764. /* USB 2.0 defines three speeds, here's how Linux identifies them */
  765.  
  766. enum usb_device_speed {
  767.     USB_SPEED_UNKNOWN = 0,            /* enumerating */
  768.     USB_SPEED_LOW, USB_SPEED_FULL,        /* usb 1.1 */
  769.     USB_SPEED_HIGH,                /* usb 2.0 */
  770.     USB_SPEED_VARIABLE,            /* wireless (usb 2.5) */
  771.     USB_SPEED_SUPER,            /* usb 3.0 */
  772. };
  773.  
  774. enum usb_device_state {
  775.     /* NOTATTACHED isn't in the USB spec, and this state acts
  776.      * the same as ATTACHED ... but it's clearer this way.
  777.      */
  778.     USB_STATE_NOTATTACHED = 0,
  779.  
  780.     /* chapter 9 and authentication (wireless) device states */
  781.     USB_STATE_ATTACHED,
  782.     USB_STATE_POWERED,            /* wired */
  783.     USB_STATE_RECONNECTING,            /* auth */
  784.     USB_STATE_UNAUTHENTICATED,        /* auth */
  785.     USB_STATE_DEFAULT,            /* limited function */
  786.     USB_STATE_ADDRESS,
  787.     USB_STATE_CONFIGURED,            /* most functions */
  788.  
  789.     USB_STATE_SUSPENDED
  790.  
  791.     /* NOTE:  there are actually four different SUSPENDED
  792.      * states, returning to POWERED, DEFAULT, ADDRESS, or
  793.      * CONFIGURED respectively when SOF tokens flow again.
  794.      * At this level there's no difference between L1 and L2
  795.      * suspend states.  (L2 being original USB 1.1 suspend.)
  796.      */
  797. };
  798.  
  799. #endif /* __LINUX_USB_CH9_H */
  800.